/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package za.co.pbt.springshark;

import org.enhydra.shark.api.client.wfmc.wapi.WMSessionHandle;
import org.enhydra.shark.api.client.wfservice.SharkConnection;
import org.enhydra.shark.api.client.wfservice.SharkInterface;

/**
 * Enhydra Shark callback which allows code to be executed with a <code>WMSessionHandle</code>.
 *
 * @since 1.0
 */
public interface EnhydraSharkSessionCallback {

  /**
   * Callback for the Shark operations that need a <code>WMSessionHandle</code>
   *
   * @param sharkInterface  the sharkInterface from which the connection was obtained
   * @param sharkConnection the sharkConnection to use
   * @param sessionHandle   the session with which the operation is executed
   * @return any object
   * @throws Exception thrown by Enhydra Shark operations
   */
  public Object doWithEnhydraSharkSession(SharkInterface sharkInterface, SharkConnection sharkConnection, WMSessionHandle sessionHandle) throws Exception;
}